/* ==============================================================================
*
*   Copyright (c) 2010, Pierre Favier
*   All rights reserved.
*
*   NTasking is free software: you can redistribute it and/or modify it
*   under the terms of the GNU General Public License as published by the
*   Free Software Foundation.
*
*   Redistribution and use in source and binary forms, with or without
*   modification, are permitted provided that the following conditions
*   are met:
*
*   -   Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*
*   -   Redistributions in binary form must reproduce the above
*       copyright notice, this list of conditions and the following
*       disclaimer in the documentation and/or other materials
*       provided with the distribution.
*
*   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
*   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
*   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
*   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
*   BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
*   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
*   TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
*   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
*   ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
*   TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
*   THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
*   SUCH DAMAGE.
*
* ============================================================================== */

using System;
using NUnit.Framework;
using Rhino.Mocks;

namespace NTasking.ValidationTests.ACATS_3_0.C9
{

    [TestFixture(Description = "")]
    public class C9740007 : ValidationTest
    {

        private static bool AbortablePartExecuted = false;
        private static bool PerformTransactionExecuted = false;
        private static bool TriggeringStatementExecuted = false;


        internal enum KeyEnum
        {
            None,
            Cancel,
            Deposit,
            Withdraw
        }


        internal class ATMCardType
        {
            public int Number { get; set; }
            public int Pin { get; set; }
        }


        internal class TransactioCancelled : Exception { }


        internal class ATMKeybordProtected : Protected
        {

            [Entry]
            internal Action CancelPressed { get; private set; }

            [ReadWriteOperation]
            internal Action ReadKey { get; private set; }


            private KeyEnum lastKeyPressed = KeyEnum.None;


            internal ATMKeybordProtected()
            {
                // Barrier is false for the live of the test
                Entry(CancelPressed,
                    When: () => lastKeyPressed == KeyEnum.Cancel,
                Is: () =>
                {
                    TriggeringStatementExecuted = true;
                });


                // Never called
                ReadWriteOperation(ReadKey, () =>
                {
                    // Simulate a procedure which processes user keyboard input, and
                    // which is called by some interrupt handler.
                    lastKeyPressed = KeyEnum.Cancel;
                });
            }

        }


        private static void ReadCard(ATMCardType card)
        {
            card.Number = 9999;
            card.Pin = 111;
        }


        private static void ValidateCard(ATMCardType card, IValidationTestResult result)
        {
            AbortablePartExecuted = true;
        }


        private static void PerformTransaction(ATMCardType card, IValidationTestResult result)
        {
            PerformTransactionExecuted = true;
        }


        [Test(Description =
            "Check that the sequence of statements of the triggering alternative " +
            "of an asynchronous select statement is not executed if the triggering " +
            "statement is a protected entry call, and the entry is not accepted " +
            "immediately. Check that the corresponding entry body is executed " +
            "before the abortable part completes. Check that execution continues " +
            "immediately following the asynchronous select.")]
        public void Test()
        {
            IValidationTestResult result = Mocks.DynamicMock<IValidationTestResult>();
            
            ATMKeybordProtected keyboard = null;
            ATMCardType card = new ATMCardType();

            ReadCard(card);

            Ada.Declare(() =>
            {
                keyboard = new ATMKeybordProtected();

                // Setup test expectations

                Expect.Call(result.TestFailed).Repeat.Never();

                Mocks.ReplayAll();
            },
            Begin: () =>
            {
                // Start test execution

                //
                // Asynchronous select is tested here
                // 

                // Barrier is never set true, so entry call is queued and never accepted.
                keyboard.CancelPressed.Select(() =>
                {
                    // Should not be executed.
                    throw new TransactioCancelled();
                }).
                ThenAbort(() =>
                {
                    // This call completes before Keyboard.Cancel_Pressed can be accepted.
                    ValidateCard(card, result);
                });

                // Execution proceeds here after Validate_Card completes.
                PerformTransaction(card, result);

                if (TriggeringStatementExecuted)
                    // Triggering statement was executed
                    result.TestFailed();

                if (! AbortablePartExecuted)
                    // Abortable part not executed
                    result.TestFailed();

                if (!PerformTransactionExecuted)
                    // Statements following asynchronous select not executed
                    result.TestFailed();
            },
            Exception: (ex) =>
            {
                if (ex is TransactioCancelled)
                {
                    // Triggering alternative sequence of statements executed
                    result.TestFailed();
                }
                else
                {
                    // Wrong exception raised
                    result.TestFailed();
                }
                return false;
            });

        }

    }

}
